Skip to content

docs: add user guide with screenshots - #130

Merged
its-mash merged 3 commits into
mainfrom
docs/add-user-guide
Feb 20, 2026
Merged

docs: add user guide with screenshots#130
its-mash merged 3 commits into
mainfrom
docs/add-user-guide

Conversation

@its-mash

Copy link
Copy Markdown
Member

Summary

  • Adds 9 comprehensive MDX documentation pages covering all McpMux concepts: Spaces, FeatureSets, Clients, Servers, Gateway, Security, Getting Started, Server Definitions schema, and overview
  • Embeds 12 existing screenshots from the discover UI into the relevant docs pages for visual reference
  • Includes sidebar ordering via meta.json with Getting Started / Core Concepts / Advanced sections
  • Adds GitHub Action (docs-deploy.yml) to trigger Cloudflare Pages rebuild when docs/guide/** changes on main

How it works

The MDX source files live here in the public mcp-mux repo. At build time, mcpmux.discover.ui runs fetch-docs.mjs which copies these files into its content/docs/ directory. Fumadocs renders them at mcpmux.com/docs/.

New files

  • docs/guide/*.mdx — 9 documentation pages + meta.json sidebar config
  • .github/workflows/docs-deploy.yml — auto-triggers website rebuild on docs changes

Test plan

  • pnpm build passes in mcpmux.discover.ui with all 55 static pages generated
  • All 9 docs pages return 200 in dev server
  • Screenshots render correctly from /screenshots/ path
  • Verify production deploy renders docs at mcpmux.com/docs/

…uninstall confirm

- Headers from server definitions are now always applied as default_headers
  on the reqwest::Client regardless of auth strategy (OAuth, PAT, or no-auth)
- If headers contain an Authorization header, OAuth is skipped entirely
- If headers have no Authorization, they ride alongside OAuth tokens
- Add build_default_headers() and build_http_client() helpers
- Remove standalone connect_with_headers() in favor of orthogonal design
- Add 19 unit tests for HttpTransport (requires_oauth, header building,
  connect routing logic, transport_type, description)
- Remove broken confirm() dialog from server uninstall action

Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
Adds comprehensive documentation covering McpMux concepts (Spaces,
FeatureSets, Clients, Gateway, Security), getting started guide,
server management, and server definition schema reference.

Content is sourced by mcpmux.discover.ui at build time via
fetch-docs.mjs and rendered with Fumadocs on mcpmux.com/docs.

Includes GitHub Action to trigger Cloudflare Pages rebuild when
docs change on main.

Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
@its-mash
its-mash enabled auto-merge (squash) February 20, 2026 08:41
@its-mash
its-mash disabled auto-merge February 20, 2026 08:42
@its-mash
its-mash merged commit a97a133 into main Feb 20, 2026
3 checks passed
@its-mash
its-mash deleted the docs/add-user-guide branch February 20, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant